public abstract class JIDLCanvas extends java.awt.Canvas implements JIDLObjectI, java.awt.event.ComponentListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, JIDLMouseListener, JIDLMouseMotionListener, JIDLKeyListener, JIDLComponentListener, JIDLCursorSupport
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Canvas
|
+--com.idl.javaidl.JIDLCanvas
javax.accessibility.Accessible, java.awt.event.ComponentListener, java.util.EventListener, java.awt.image.ImageObserver, JIDLComponentListener, JIDLCursorSupport, JIDLKeyListener, JIDLMouseListener, JIDLMouseMotionListener, JIDLObjectI, java.awt.event.KeyListener, java.awt.MenuContainer, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.io.Serializable
This class wraps an IDL object of type IDLitWindow in a java.awtCanvas providing direct rendering of the object from IDL.
Note: JIDLCanvas is not supported on Macintosh OS X.
In many of the methods of this class, one or more flags are required to be specified for parameters being passed to or from the bridge. These flags follow the following guidelines:
For all types of parameters (subclasses of JIDLNumber, JIDLString, JIDLObjectI and JIDLArray), a flag should be set that determines whether the parameter is in-only (const) or in-out (we expect it to be changed by IDL). The constants that determine this are either JIDLConst.PARMFLAG_CONST or JIDLConst.PARMFLAG_IN_OUT.
For parameters that are arrays, a flag should be set that tells the bridge whether the array is to be convolved when passed to IDL. If the PARM_IN_OUT flag is set, this flag will also tell the bridge whether to convolve the array when it is copied back to Java. The constants that determine this are either JIDLConst.PARMFLAG_CONVMAJORITY or JIDLConst.PARMFLAG_NO_CONVMAJORITY.
For example, if the parameter in question is an array that is to be modified by IDL (in-out) and needs to be convolved when passed to and from IDL, we would set its argpal array member as follows:
argpal[2] = JIDLConst.PARMFLAG_IN_OUT | JIDLConst.PARMFLAG_CONV MAJORITY;
IDL_SOFTWARE_RENDERER
Internal use
OPENGL_RENDERER
Internal use
JIDLCanvas(java.lang.String sClass, int iOPSFlags, java.lang.String sProcessName)
Construct a JIDLCanvas
JIDLCanvas(java.lang.String sClass, java.lang.String sProcessName)
Construct a JIDLCanvas Note that constructing the JIDLObject does NOT create the object on the IDL-side of the bridge.
abort()
Requests that the IDL process containing the underlying IDL object abort its current activity.
addIDLComponentListener(JIDLComponentListener listener)
Adds the specified JIDLComponentListener to a list of listeners that receive notification of Component events.
addIDLKeyListener(JIDLKeyListener listener)
Adds the specified JIDLKeyListener to a list of listeners that receive notification of Key events.
addIDLMouseListener(JIDLMouseListener listener)
Adds the specified JIDLMouseListener to a list of listeners that receive notification of Mouse events.
addIDLMouseMotionListener(JIDLMouseMotionListener listener)
Adds the specified JIDLMouseMotionListener to a list of listeners that receive notification of MouseMotion events.
addIDLMouseWheelListener(JIDLMouseWheelListener listener)
Adds the specified JIDLMouseWheelListener to a list of listeners that receive notification of MouseWheel events.
addIDLNotifyListener(JIDLNotifyListener listener)
Adds the specified IDL notify listener to receive IDL notification events on this object.
addIDLOutputListener(JIDLOutputListener listener)
Adds the specified IDL output listener to receive IDL output events on this object.
callFunction(java.lang.String sMethodName, int iPalFlag)
Call IDL function that accepts zero parameters.
callFunction(java.lang.String sMethodName, int argc, java.lang.Object argv, int[] argpal, int iPalFlag)
Call IDL function.
callProcedure(java.lang.String sMethodName)
Call IDL procedure that accepts zero parameters.
callProcedure(java.lang.String sMethodName, int argc, java.lang.Object argv, int[] argpal)
Call IDL procedure.
componentHidden(java.awt.event.ComponentEvent e)
Called when the component is hidden.
componentMoved(java.awt.event.ComponentEvent e)
Called when the component is moved.
componentResized(java.awt.event.ComponentEvent e)
Internal use.
componentShown(java.awt.event.ComponentEvent e)
Called when the component is shown.
createObject()
Create the wrapped object by calling IDL’s ::INIT method.
createObject(int argc, java.lang.Object argv, int[] argpal)
Create the wrapped object by calling IDL’s ::INIT method.
createObject(int argc, java.lang.Object argv, int[] argpal, com.idl.javaidl.JIDLProcessInitializer initializer)
Create the wrapped object by calling IDL’s ::INIT method.
createObject(com.idl.javaidl.JIDLProcessInitial izer initializer)
Create the wrapped object by calling IDL’s ::INIT method.
destroyObject()
Destroys the underlying IDL object associated with the wrapper.
draw()
Internal use.
executeString(java.lang.String sCmd)
Execute the given command string in IDL.
getClassName()
Get the class name of the object.
getCookie()
Internal use.
getIDLObjectClassName()
Retrieves the IDL object class name of the underlying IDL object.
getIDLObjectVariableName()
When the underlying IDL object was created in the IDL process, it was assigned a variable name.
getIDLVariable(java.lang.String sVar)
Given a variable name, return the IDL variable.
getObjVariableName()
Get the IDL Variable name of the given object
getProcessName()
Returns the name of the process that contains the underlying IDL object.
getProperty(java.lang.String sProperty, int iPalFlag)
Call IDL getProperty method to get named property.
IDLcomponentExposed(JIDLObjectI obj)
Called when the JIDLCanvas is exposed.
IDLcomponentResized(JIDLObjectI obj, java.awt.event.ComponentEvent e)
Called when the JIDLCanvas is resized.
IDLkeyPressed(JIDLObjectI obj, java.awt.event.KeyEvent e, int x, int y)
Called when the JIDLCanvas has focus and a key is pressed.
IDLkeyReleased(JIDLObjectI obj, java.awt.event.KeyEvent e, int x, int y)
Called when the JIDLCanvas has focus and a key is released.
IDLmouseDragged(JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is dragged in a JIDLCanvas.
IDLmouseEntered(JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse enters a JIDLCanvas.
IDLmouseExited(JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse exits a JIDLCanvas.
IDLmouseMoved(JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is moved in a JIDLCanvas.
IDLmousePressed(JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is pressed in a JIDLCanvas.
IDLmouseReleased(JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is released in a JIDLCanvas.
initListeners()
Initialize listeners.
isFocusTraversable()
Internal use.
isObjCreated()
Determine if object has been created successfully.
isObjectCreated()
Determine if object has been created successfully.
isObjectDisplayable()
keyPressed(java.awt.event.KeyEvent e)
Internal use.
keyReleased(java.awt.event.KeyEvent e)
Internal use.
keyTyped(java.awt.event.KeyEvent e)
Internal use.
mapIDLCursorToJavaCursor(java.lang.String idlCursor)
Maps the IDL cursor to a suitable Java cursor.
mouseClicked(java.awt.event.MouseEvent e)
Internal use.
mouseDragged(java.awt.event.MouseEvent e)
Internal use.
mouseEntered(java.awt.event.MouseEvent e)
Internal use.
mouseExited(java.awt.event.MouseEvent e)
Internal use.
mouseMoved(java.awt.event.MouseEvent e)
Internal use.
mousePressed(java.awt.event.MouseEvent e)
Internal use.
mouseReleased(java.awt.event.MouseEvent e)
Internal use.
paint(java.awt.Graphics g)
Internal use.
removeIDLComponentListener(JIDLComponentListener listener)
Remove the specified JIDLComponentListener from a list of listeners that receive notification of Component events.
removeIDLKeyListener(JIDLKeyListener listener)
Removes the specified JIDLKeyListener from a list of listeners that receive notification of Key events.
removeIDLMouseListener(JIDLMouseListener listener)
Removes the specified JIDLMouseListener from a list of listeners that receive notification of Mouse events.
removeIDLMouseMotionListener(JIDLMouseMotionListener listener)
Removes the specified JIDLMouseMotionListener from a list of listeners that receive notification of MouseMotion events.
removeIDLMouseWheelListener(JIDLMouseWheelListener listener)
Removes the specified JIDLMouseWheelListener from a list of listeners that receive notification of MouseWheel events.
removeIDLNotifyListener(JIDLNotifyListener listener)
Removes the specified IDL notify listener so it no longer receives IDL notifications.
removeIDLOutputListener(JIDLOutputListener listener)
Removes the specified IDL output listener on this object.
setCursor(java.lang.String idlCursor)
Set the JIDLCanvas cursor.
setIDLVariable(java.lang.String sVar, java.lang.Object obj)
Set/Create an IDL variable of the given name and value.
setProcessName(java.lang.String process)
Set the process name that the object will be created in.
setProperty(java.lang.String sProperty, java.lang.Object obj, int iPalFlag)
Call IDL setProperty method to set named property.
toString()
Returns a string representation of the object.
update(java.awt.Graphics g)
Internal use.
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
addNotify(), createBufferStrategy(int, BufferCapabilities), createBufferStrategy(int, BufferCapabilities), getAccessibleContext(), getBufferStrategy()
action(Event, Object), add(PopupMenu), addComponentListener(ComponentListener), addFocusListener(FocusListener), addHierarchyBoundsListener(HierarchyBoundsListener), addHierarchyListener(HierarchyListener), addInputMethodListener(InputMethodListener), addKeyListener(KeyListener), addMouseListener(MouseListener), addMouseMotionListener(MouseMotionListener), addMouseWheelListener(MouseWheelListener), addPropertyChangeListener(String, PropertyChangeListener), addPropertyChangeListener(String, PropertyChangeListener), applyComponentOrientation(ComponentOrientation), areFocusTraversalKeysSet(int), bounds(), checkImage(Image, ImageObserver), checkImage(Image, ImageObserver), contains(Point), contains(Point), createImage(ImageProducer), createImage(ImageProducer), createVolatileImage(int, int, ImageCapabilities), createVolatileImage(int, int, ImageCapabilities), deliverEvent(Event), disable(), dispatchEvent(AWTEvent), doLayout(), enable(boolean), enable(boolean), enableInputMethods(boolean), getAlignmentX(), getAlignmentY(), getBackground(), getBounds(Rectangle), getBounds(Rectangle), getColorModel(), getComponentAt(Point), getComponentAt(Point), getComponentListeners(), getComponentOrientation(), getCursor(), getDropTarget(), getFocusCycleRootAncestor(), getFocusListeners(), getFocusTraversalKeys(int), getFocusTraversalKeysEnabled(), getFont(), getFontMetrics(Font), getForeground(), getGraphics(), getGraphicsConfiguration(), getHeight(), getHierarchyBoundsListeners(), getHierarchyListeners(), getIgnoreRepaint(), getInputContext(), getInputMethodListeners(), getInputMethodRequests(), getKeyListeners(), getListeners(Class), getLocale(), getLocation(Point), getLocation(Point), getLocationOnScreen(), getMaximumSize(), getMinimumSize(), getMouseListeners(), getMouseMotionListeners(), getMouseWheelListeners(), getName(), getParent(), getPeer(), getPreferredSize(), getPropertyChangeListeners(String), getPropertyChangeListeners(String), getSize(Dimension), getSize(Dimension), getToolkit(), getTreeLock(), getWidth(), getX(), getY(), gotFocus(Event, Object), handleEvent(Event), hasFocus(), hide(), imageUpdate(Image, int, int, int, int, int), inside(int, int), invalidate(), isBackgroundSet(), isCursorSet(), isDisplayable(), isDoubleBuffered(), isEnabled(), isFocusCycleRoot(Container), isFocusOwner(), isFocusable(), isFontSet(), isForegroundSet(), isLightweight(), isOpaque(), isShowing(), isValid(), isVisible(), keyDown(Event, int), keyUp(Event, int), layout(), list(PrintWriter, int), list(PrintWriter, int), list(PrintWriter, int), list(PrintWriter, int), list(PrintWriter, int), locate(int, int), location(), lostFocus(Event, Object), minimumSize(), mouseDown(Event, int, int), mouseDrag(Event, int, int), mouseEnter(Event, int, int), mouseExit(Event, int, int), mouseMove(Event, int, int), mouseUp(Event, int, int), move(int, int), nextFocus(), paintAll(Graphics), postEvent(Event), preferredSize(), prepareImage(Image, ImageObserver), prepareImage(Image, ImageObserver), print(Graphics), printAll(Graphics), remove(MenuComponent), removeComponentListener(ComponentListener), removeFocusListener(FocusListener), removeHierarchyBoundsListener(HierarchyBoundsListener), removeHierarchyListener(HierarchyListener), removeInputMethodListener(InputMethodListener), removeKeyListener(KeyListener), removeMouseListener(MouseListener), removeMouseMotionListener(MouseMotionListener), removeMouseWheelListener(MouseWheelListener), removeNotify(), removePropertyChangeListener(String, PropertyChangeListener), removePropertyChangeListener(String, PropertyChangeListener), repaint(long, int, int, int, int), repaint(long, int, int, int, int), repaint(long, int, int, int, int), repaint(long, int, int, int, int), requestFocus(), requestFocusInWindow(), reshape(int, int, int, int), resize(Dimension), resize(Dimension), setBackground(Color), setBounds(Rectangle), setBounds(Rectangle), setComponentOrientation(ComponentOrientation), setCursor(Cursor), setDropTarget(DropTarget), setEnabled(boolean), setFocusTraversalKeys(int, Set), setFocusTraversalKeysEnabled(boolean), setFocusable(boolean), setFont(Font), setForeground(Color), setIgnoreRepaint(boolean), setLocale(Locale), setLocation(Point), setLocation(Point), setName(String), setSize(Dimension), setSize(Dimension), setVisible(boolean), show(boolean), show(boolean), size(), transferFocus(), transferFocusBackward(), transferFocusUpCycle(), validate()
equals(Object), getClass(), hashCode(), notify(), notifyAll(), wait(long, int), wait(long, int), wait(long, int)
public static final int IDL_SOFTWARE_RENDERER
Internal use
public static final int OPENGL_RENDERER
Internal use
public JIDLCanvas(java.lang.String sClass, int iOPSFlags, java.lang.String sProcessName)
Replaced by constructor taking 2 parameters
Construct a JIDLCanvas
sClass - IDL Class name
iOPSFlags - Unused. The process name determines the OPS flags.
sProcessName - The process name. If null or “”, in-process is used.
public JIDLCanvas(java.lang.String sClass, java.lang.String sProcessName)
Construct a JIDLCanvas Note that constructing the JIDLObject does NOT create the object on the IDL-side of the bridge. This is done using the createObject method.
sClass - IDL Class name
sProcessName - The process name. If null or “”, in-process is used.
public void abort()
Requests that the IDL process containing the underlying IDL object abort its current activity.
This is only a request and IDL may take a long time before it actually stops.
The client can only Abort the current IDL activity if that wrapper object is the current “owner” of the underlying IDL.
abort in interface JIDLObjectI
JIDLException - If IDL encounters an error.
JIDLAbortedException
public void addIDLComponentListener(com.idl.javaidl.JIDLComponentListener listener)
Adds the specified JIDLComponentListener to a list of listeners that receive notification of Component events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLComponentListener
public void addIDLKeyListener(com.idl.javaidl.JIDLKeyListener listener)
Adds the specified JIDLKeyListener to a list of listeners that receive notification of Key events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLKeyListener
public void addIDLMouseListener(com.idl.javaidl.JIDLMouseListener listener)
Adds the specified JIDLMouseListener to a list of listeners that receive notification of Mouse events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLMouseListener
public void addIDLMouseMotionListener(com.idl.javaidl.JIDLMouseMotionListener listener)
Adds the specified JIDLMouseMotionListener to a list of listeners that receive notification of MouseMotion events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLMouseMotionListener
public void addIDLMouseWheelListener(com.idl.javaidl.JIDLMouseWheelListener listener)
Adds the specified JIDLMouseWheelListener to a list of listeners that receive notification of MouseWheel events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLMouseWheelListener
public void addIDLNotifyListener(com.idl.javaidl.JIDLNotifyListener listener)
Adds the specified IDL notify listener to receive IDL notification events on this object.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
addIDLNotifyListener in interface JIDLObjectI
listener - the listener
public void addIDLOutputListener(com.idl.javaidl.JIDLOutputListener listener)
Adds the specified IDL output listener to receive IDL output events on this object. Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
addIDLOutputListener in interface JIDLObjectI
listener - the listener
public java.lang.Object callFunction(java.lang.StringsMethodName, int iPalFlag)
Call IDL function that accepts zero parameters.
sMethodName - the function name
iPalFlag - a flag determining whether a returned array is convolved or not. If the returned value is not an array, this value is zero. See class description for more information.
an Object of type JIDLNumber, JIDLString, JIDLObject or JIDLArray. The caller must know the type of the Object being returned and cast it to its proper type. May also return null.
JIDLException - If IDL encounters an error.
callFunction(String, int, Object[], int[], int)
public java.lang.Object callFunction(java.lang.String sMethodName, int argc, java.lang.Object[] argv, int[] argpal, int iPalFlag)
Call IDL function.
The argpal parameter is an array of flags created by OR-ing constants from class JIDLConst. Each array element corresponds to the equivalent parameter in argv.
callFunction in interface JIDLObjectI
sMethodName - the procedure name
argc - the number of parameters
argv - array of Objects to be passed to IDL. This array should be of length argc and should contain objects of type JIDLNumber, JIDLObject, JIDLString or JIDLObject.
argpal - array of flags denoting whether each argv parameter passed to be bridge is 1) in-out vs constant; or 2) a convolved or non-convolved array This array should be of length argc.
iPalFlag - a flag determining whether a returned array if convolved or not. If the returned value is not an array, this value is zero.
an Object of type JIDLNumber, JIDLString, JIDLObjectI or JIDLArray. The caller must know the type of the Object being returned and cast it to its proper type.
JIDLException - If IDL encounters an error.
JIDLNumber, JIDLObject, JIDLString, JIDLArray, JIDLConst.PARMFLAG_CONST, JIDLConst.PARMFLAG_IN_OUT, JIDLConst.PARMFLAG_CONVMAJORITY, JIDLConst.PARMFLAG_NO_CONVMAJORITY
public void callProcedure(java.lang.String sMethodName)
Call IDL procedure that accepts zero parameters.
sMethodName - the procedure name
JIDLException - If IDL encounters an error.
callProcedure(String, int, Object[], int[])
public void callProcedure(java.lang.String sMethodName, int argc, java.lang.Object[] argv, int[] argpal)
Call IDL procedure.
The argpal parameter is an array of flags created by OR-ing constants from class JIDLConst. Each array element corresponds to the equivalent parameter in argv.
callProcedure in interface JIDLObjectI
sMethodName - the procedure name
argc - the number of parameters
argv - array of Objects to be passed to IDL. This array should be of length argc and should contain objects of type JIDLNumber, JIDLObject, JIDLString or JIDLObject.
argpal - array of flags denoting whether each argv parameter passed to be bridge is 1) in-out vs constant; or 2) a convolved or non-convolved array This array should be of length argc.
JIDLException - If IDL encounters an error.
JIDLNumber, JIDLObject, JIDLString, JIDLArray, JIDLConst.PARMFLAG_CONST, JIDLConst.PARMFLAG_IN_OUT, JIDLConst.PARMFLAG_CONVMAJORITY, JIDLConst.PARMFLAG_NO_CONVMAJORITY
public void componentHidden(java.awt.event.ComponentEvent e)
Called when the component is hidden.
This method does nothing because IDL does not care about this event. This could be overridden by a child of JIDLCanvas if these events were of interest to the client application
componentHidden in interface ComponentListener
java.awt.event.ComponentListener
public void componentMoved(java.awt.event.ComponentEvent e)
Called when the component is moved.
This method does nothing because IDL does not care about this event. This could be overridden by a child of JIDLCanvas if these events were of interest to the client application
componentMoved in interface ComponentListener
java.awt.event.ComponentListener
public final void componentResized(java.awt.event.ComponentEvent e)
Internal use.
Called when the JIDLCanvas is resized.
If interested in resize events, use IDLcomponentResized. This method should NOT be overridden by a child of JIDLCanvas.
componentResized in interface ComponentListener
JIDLComponentListener, IDLcomponentResized(JIDLObjectI, ComponentEvent)
public void componentShown(java.awt.event.ComponentEvent e)
Called when the component is shown.
This method does nothing because IDL does not care about this event. This could be overridden by a child of JIDLCanvas if these events were of interest to the client application
componentShown in interface ComponentListener
java.awt.event.ComponentListener
public void createObject()
Create the wrapped object by calling IDL’s ::INIT method. Used for ::INIT methods that take zero parameters.
JIDLException - If IDL encounters an error.
createObject(int, Object[], int[])
public void createObject(int argc, java.lang.Object[] argv, int[] argpal)
Create the wrapped object by calling IDL’s ::INIT method.
Note that the GUI that this Canvas lives in must be exposed before the createObject method is called.
createObject does the following:
The argpal parameter is an array of flags created by OR-ing constants from class JIDLConst. Each array element corresponds to the equivalent parameter in argv. See the class description for more information.
createObject in interface JIDLObjectI
argc - the number of parameters
argv - array of Objects to be passed to IDL. This array should be of length argc and should contain objects of type JIDLNumber, JIDLObject, JIDLString or JIDLObject.
argpal - array of flags denoting whether each argv parameter passed to be bridge is 1) in-out vs constant; or 2) a convolved or non-convolved array This array should be of length argc.
JIDLException - If IDL encounters an error.
JIDLConst, initListeners()
public void createObject(int argc, java.lang.Object[] argv, int[] argpal, com.idl.javaidl.JIDLProcessInitializer initializer)
Create the wrapped object by calling IDL’s ::INIT method.
Note that the GUI that this Canvas lives in must be exposed before the createObject method is called.
createObject does the following:
• Calls ::Init method in the IDL object
• Calls the superclass initListeners method to initialize any event handlers. The initListeners method has default behavior, which is different for graphical and non-graphical objects. If the default behavior is not desired, a sub-class to modify the listener initialization may override the initListeners method.
createObject in interface JIDLObjectI
argc - the number of parameters to be passed to INIT
argv - array of Objects to be passed to IDL. This array should be of length argc and should contain objects of type JIDLNumber, JIDLObject, JIDLString or JIDLArray.
argpal - array of flags denoting whether each argv parameter that is of type array should be convolved or not. For parameters that are not arrays, the value within the array will always be 0.
initializer - a JIDLProcessInitializer object that specifies IDL process initialization parameters such as the licensing mode to be used. See “IDL Licensing Modes” on page 136 for details on the default licensing mechanism used when no JIDLProcessInitializer is specified.
JIDLException - If IDL encounters an error.
public void createObject(com.idl.javaidl.JIDLProcessInitializer initializer)
Create the wrapped object by calling IDL’s ::INIT method. Used for ::INIT methods that take zero parameters.
The initializer parameter is used to supply IDL process initialization values.
Note that the GUI that this Canvas lives in must be exposed before the createObject method is called.
initializer - a JIDLProcessInitializer object that specifies IDL process initialization parameters such as the licensing mode to be used. See “IDL Licensing Modes” on page 136 for details on the default licensing mechanism used when no JIDLProcessInitializer is specified.
JIDLException - If IDL encounters an error.
public void destroyObject()
Destroys the underlying IDL object associated with the wrapper.
If the object being destroyed is the last object within an OPS process, the OPS process is also destroyed.
Note that this does not destroy the actual wrapper object. Because the wrapper object is a Java object, it follows all the Java reference counting/garbage collection schemes. Once all references to the wrapper object are released from Java code and once the Java Virtual Machine calls the garbage collector, the wrapper object may be deleted from memory.
destroyObject in interface JIDLObjectI
public void draw()
Internal use.
Call IDL to inform the Canvas has been exposed to cause a redraw.
This in turn calls all the JIDLComponentListeners. Should not be overridden.
public void executeString(java.lang.String sCmd)
Execute the given command string in IDL.
executeString in interface JIDLObjectI
sCmd - the single-line command to execute in IDL.
JIDLException - If IDL encounters an error.
public java.lang.String getClassName()
Deprecated.
Replaced by getIDLObjectClassName() Get the class name of the object.
class name (“” if object not created yet)
public long getCookie()
Internal use.
getCookie in interface JIDLObjectI
public java.lang.String getIDLObjectClassName()
Retrieves the IDL object class name of the underlying IDL object.
getIDLObjectClassName in interface JIDLObjectI
the IDL object class name
public java.lang.String getIDLObjectVariableName()
When the underlying IDL object was created in the IDL process, it was assigned a variable name. This method retrieves that name.
getIDLObjectVariableName in interface JIDLObjectI
the variable name
public java.lang.Object getIDLVariable(java.lang.String sVar)
Given a variable name, return the IDL variable.
Note that in the case of arrays, the array will ALWAYS be convolved when passed between Java and IDL.
getIDLVariable in interface JIDLObjectI
sVar - The IDL variable name
an Object of type JIDLNumber, JIDLString, JIDLObject or JIDLArray. The caller must know the type of the Object being returned and cast it to its proper type. May also return null.
JIDLException - If IDL encounters an error.
public java.lang.String getObjVariableName()
Deprecated.
Replaced by getIDLObjectVariableName()
Get the IDL Variable name of the given object
a String representing the IDL Variable name
public java.lang.String getProcessName()
Returns the name of the process that contains the underlying IDL object. For an in- process object, returns an empty string.
getProcessName in interface JIDLObjectI
process name. Empty string if the process is in-process.
public java.lang.Object getProperty(java.lang.StringsProperty, int iPalFlag)
Call IDL getProperty method to get named property.
getProperty in interface JIDLObjectI
sProperty - the property name
iPalFlag - a flag determining whether a returned array will be convolved or not. If the returned value is not is ignored.
an Object of type JIDLNumber, JIDLString, JIDLObject or JIDLArray. The caller must know the type of the Object being returned and cast it to its proper type. May also return null.
JIDLException - If IDL encounters an error.
JIDLNumber, JIDLObjectI, JIDLString, JIDLArray, JIDLConst.PARMFLAG_CONVMAJORITY, JIDLConst.PARMFLAG_NO_CONVMAJORITY
public void IDLcomponentExposed(com.idl.javaidl.JIDLObjectI obj)
Called when the JIDLCanvas is exposed.
The default behavior of this method is to lock the Canvas, pass the event on to IDL to handle (i.e. redraw), and then unlock the Canvas.
The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to do something special before or after the redraw happens. The method would be implemented as follows:
public class mySubClass extends JIDLCanvas {
public void IDLcomponentExposed() {
// do something here before IDL is called
super.IDLcomponentExposed();
// do something if desired afterwards
}
}
IDLcomponentExposed in interface JIDLComponentListener
JIDLComponentListener, initListeners()
public void IDLcomponentResized(com.idl.javaidl.JIDLObjectI obj, java.awt.event.ComponentEvent e)
Called when the JIDLCanvas is resized.
The default behavior of this method is to send the resize event to IDL to handle.
IDLcomponentResized in interface JIDLComponentListener
JIDLComponentListener, initListeners()
public void IDLkeyPressed(com.idl.javaidl.JIDLObjectI obj, java.awt.event.KeyEvent e, int x, int y)
Called when the JIDLCanvas has focus and a key is pressed.
The default behavior of this method is pass the event to IDL which, if registered for the event will call ::OnKeyboard.
The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to ignore the event by providing an empty implementation of the method. Or the sub-class may do something special before or after the event happens.
See IDLcomponentExposed for an example of how this would be done.
IDLkeyPressed in interface JIDLKeyListener
JIDLKeyListener, IDLcomponentExposed(JIDLObjectI), initListeners()
public void IDLkeyReleased(com.idl.javaidl.JIDLObjectI obj, java.awt.event.KeyEvent e, int x, int y)
Called when the JIDLCanvas has focus and a key is released.
The default behavior of this method is pass the event to IDL which, if registered for the event will call ::OnKeyboard. The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to ignore the event by providing an empty implementation of the method. Or the sub-class may do something special before or after the event happens. See IDLcomponentExposed for an example of how this would be done.
IDLkeyReleased in interface JIDLKeyListener
JIDLKeyListener, IDLcomponentExposed(JIDLObjectI), initListeners()
public void IDLmouseDragged(com.idl.javaidl.JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is dragged in a JIDLCanvas.
The default behavior of this method is pass the event to IDL which, if registered for the event, will call ::OnMouseMotion.
The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to ignore the event by providing an empty implementation of the method. Often our IDL IDLitWindow is only interested in one type of motion event and not another. Or the sub-class may do something special before or after the event happens.
See IDLcomponentExposed for an example of how this would be done.
IDLmouseDragged in interface JIDLMouseMotionListener
JIDLMouseMotionListener, IDLcomponentExposed(JIDLObjectI), initListeners()
public void IDLmouseEntered(com.idl.javaidl.JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse enters a JIDLCanvas.
The default behavior of this method is to ignore the event.
The behavior may be changed by overriding this method in a sub-class.
IDLmouseEntered in interface JIDLMouseListener
JIDLMouseListener, initListeners()
public void IDLmouseExited(com.idl.javaidl.JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse exits a JIDLCanvas.
The default behavior of this method is to ignore the event.
The behavior may be changed by overriding this method in a sub-class.
IDLmouseExited in interface JIDLMouseListener
JIDLMouseListener, initListeners()
public void IDLmouseMoved(com.idl.javaidl.JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is moved in a JIDLCanvas.
The default behavior of this method is pass the event to IDL which, if registered for the event, will call ::OnMouseMotion.
The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to ignore the event by providing an empty implementation of the method. Often our IDL IDLitWindow is only interested in one type of motion event and not another. Or the sub-class may do something special before or after the event happens.
See IDLcomponentExposed for an example of how this would be done.
IDLmouseMoved in interface JIDLMouseMotionListener
JIDLMouseMotionListener, IDLcomponentExposed(JIDLObjectI), initListeners()
public void IDLmousePressed(com.idl.javaidl.JIDLObjectIobj, java.awt.event.MouseEvent e)
Called when the mouse is pressed in a JIDLCanvas.
The default behavior of this method is pass the event to IDL which, if registered for the event, will call ::OnMouseDown.
The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to ignore the event by providing an empty implementation of the method. Or the sub-class may do something special before or after the event happens.
See IDLcomponentExposed for an example of how this would be done.
IDLmousePressed in interface JIDLMouseListener
JIDLMouseListener, IDLcomponentExposed(JIDLObjectI), initListeners()
public void IDLmouseReleased(com.idl.javaidl.JIDLObjectI obj, java.awt.event.MouseEvent e)
Called when the mouse is released in a JIDLCanvas.
The default behavior of this method is pass the event to IDL which, if registered for the event, will call ::OnMouseUp.
The behavior may be changed by overriding this method in a sub-class. For example, the sub-class may want to ignore the event by providing an empty implementation of the method. Or the sub-class may do something special before or after the event happens.
See IDLcomponentExposed for an example of how this would be done.
IDLmouseReleased in interface JIDLMouseListener
JIDLMouseListener, IDLcomponentExposed(JIDLObjectI), initListeners()
public void initListeners()
Initialize listeners.
This method is always called by createObject. The JIDLCanvas listens to the following events:
• JIDLComponentListener
• JIDLKeyListener
• JIDLMouseListener
• JIDLMouseMotionListener
The method may be overridden by sub-classes to initialize a different set of listeners (or none at all). For example if a sub-class of JIDLCanvas only wished to listen to key and component events, it would override initListeners as follows:
public void initListeners()
{
addIDLComponentListener(this);
addIDLKeyListener(this);
}
As another example, if a sub-class of JIDLCanvas wished to listen to key events, component events, and notify events, it would need to implement JIDLNotifyListener and register to listen for these events in initListeners, as follows:
public class newCanvas extends JIDLCanvas implements JIDLNotifyListener
{
public void initListeners()
{
addIDLComponentListener(this);
addIDLKeyListener(this);
addIDLNotifyListener(this);
}
void OnIDLNotify(JIDLObjectI obj, String s1, String s2)
{
// do something with the notify
}
}
initListeners in interface JIDLObjectI
JIDLComponentListener, JIDLKeyListener, JIDLMouseListener, JIDLMouseMotionListener, JIDLNotifyListener, JIDLOutputListener
public boolean isFocusTraversable()
Internal use.
isFocusTraversable in class Component
public boolean isObjCreated()
Replaced by isObjectCreated()
Determine if object has been created successfully.
true if object created successfully, or false if object not created or creation was unsuccessful.
public boolean isObjectCreated()
Determine if object has been created successfully.
isObjectCreated in interface JIDLObjectI
true if object created successfully, or false if object not created, destroyed, or creation was unsuccessful.
createObject()
public boolean isObjectDisplayable()
isObjectDisplayable in interface JIDLObjectI
public final void keyPressed(java.awt.event.KeyEvent e)
Internal use.
Called when a key is pressed when the JIDLCanvas has focus.
If interested in this event, use IDLkeyPressed. This method should NOT be overridden by a child of JIDLCanvas.
keyPressed in interface KeyListener
JIDLKeyListener, IDLkeyPressed(JIDLObjectI, KeyEvent, int, int)
public final void keyReleased(java.awt.event.KeyEvent e)
Internal use.
Called when a key is released when the JIDLCanvas has focus.
If interested in this event, use IDLkeyReleased. This method should NOT be overridden by a child of JIDLCanvas.
keyReleased in interface KeyListener
JIDLKeyListener, IDLkeyReleased(JIDLObjectI, KeyEvent, int, int)
public void keyTyped(java.awt.event.KeyEvent e)
Internal use.
Called when a key is typed.
This method does nothing because IDL does not care about this event, using keyPressed to trigger its mouse events. This method should NOT be overridden by a child of JIDLCanvas.
keyTyped in interface KeyListener
public int mapIDLCursorToJavaCursor(java.lang.String idlCursor)
Maps the IDL cursor to a suitable Java cursor. This is called internally by setCursor when the IDL drawable changes the cursor.
May be overridden to change the mapping. The default mapping is as follows:
mapIDLCursorToJavaCursor in interface JIDLCursorSupport
idlCursor - a String representing the IDL cursor
the Cursor constant representing the Java Cursor style
setCursor(String)
public void mouseClicked(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse is clicked.
This method does nothing because IDL does not care about this event, using mousePressed to trigger its mouse events. This method should NOT be overridden by a child of JIDLCanvas.
mouseClicked in interface MouseListener
public final void mouseDragged(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse is dragged in the JIDLCanvas.
If interested in this event, use IDLmouseDragged. This method should NOT be overridden by a child of JIDLCanvas.
public final void mouseEntered(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse enters the JIDLCanvas.
If interested in this event, use IDLmouseEntered. This method should NOT be overridden by a child of JIDLCanvas.
mouseEntered in interface MouseListener
JIDLMouseListener, IDLmouseEntered(JIDLObjectI, MouseEvent)
public final void mouseExited(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse exits the JIDLCanvas.
If interested in this event, use IDLmouseExited. This method should NOT be overridden by a child of JIDLCanvas.
mouseExited in interface MouseListener
JIDLMouseListener, IDLmouseExited(JIDLObjectI, MouseEvent)
public final void mouseMoved(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse moves in the JIDLCanvas.
If interested in this event, use IDLmouseMoved. This method should NOT be overridden by a child of JIDLCanvas.
mouseMoved in interface MouseMotionListener
JIDLMouseMotionListener, IDLmouseMoved(JIDLObjectI, MouseEvent)
public final void mousePressed(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse is pressed.
If interested in this event, use IDLmousePressed. This method should NOT be overridden by a child of JIDLCanvas.
mousePressed in interface MouseListener
JIDLMouseListener, IDLmousePressed(JIDLObjectI, MouseEvent)
public final void mouseReleased(java.awt.event.MouseEvent e)
Internal use.
Called when the mouse is released.
If interested in this event, use IDLmouseReleased. This method should NOT be overridden by a child of JIDLCanvas.
mouseReleased in interface MouseListener
JIDLMouseListener, IDLmouseReleased(JIDLObjectI, MouseEvent)
public void paint(java.awt.Graphics g)
Internal use. Paint the Canvas. (Do not override this method)
paint in class Canvas
public void removeIDLComponentListener(com.idl.javaidl.JIDLComponentListener listener)
Remove the specified JIDLComponentListener from a list of listeners that receive notification of Component events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLComponentListener
public void removeIDLKeyListener(com.idl.javaidl.JIDLKeyListener listener)
Removes the specified JIDLKeyListener from a list of listeners that receive notification of Key events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLKeyListener
public void removeIDLMouseListener(com.idl.javaidl.JIDLMouseListener listener)
Removes the specified JIDLMouseListener from a list of listeners that receive notification of Mouse events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLMouseListener
public void removeIDLMouseMotionListener(com.idl.javaidl.JIDLMouseMotionListen er listener)
Removes the specified JIDLMouseMotionListener from a list of listeners that receive notification of MouseMotion events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLMouseMotionListener
public void removeIDLMouseWheelListener(com.idl.javaidl.JIDLMouseWheelListener listener)
Removes the specified JIDLMouseWheelListener to a list of listeners that receive notification of MouseWheel events.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
listener - the listener
JIDLMouseWheelListener
public void removeIDLNotifyListener(com.idl.javaidl.JIDLNotifyListener listener)
Removes the specified IDL notify listener so it no longer receives IDL notifications.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
removeIDLNotifyListener in interface JIDLObjectI
listener - the listener
public void removeIDLOutputListener(com.idl.javaidl.JIDLOutputListener listener)
Removes the specified IDL output listener on this object.
Note that registering/unregistering for events should happen in the initListeners method or AFTER the createObject method.
removeIDLOutputListener in interface JIDLObjectI
listener - the listener
public void setCursor(java.lang.String idlCursor)
Set the JIDLCanvas cursor. Called automatically when the IDL cursor changes. This in turn calls mapIDLCursorToJavaCursor to map the IDL cursor name to a suitable Java cursor type.
setCursor in interface JIDLCursorSupport
idlCursor - A String representing the IDL cursor name.
mapIDLCursorToJavaCursor(String)
public void setIDLVariable(java.lang.String sVar, java.lang.Object obj)
Set/Create an IDL variable of the given name and value.
Note that in the case of arrays, the array will ALWAYS be convolved when passed between Java and IDL.
setIDLVariable in interface JIDLObjectI
sVar - the IDL variable name
obj - object to be passed to IDL. Should be an object of type JIDLNumber, JIDLObject, JIDLString or JIDLArray.
JIDLException - If IDL encounters an error.
public void setProcessName(java.lang.String process)
Set the process name that the object will be created in.
The process name may only be set before createObject is called. If called after the object has been created, this method call does nothing.
setProcessName in interface JIDLObjectI
process - Process name. Empty String means create in same process (in-process).
public void setProperty(java.lang.String sProperty, java.lang.Object obj, int iPalFlag)
Call IDL setProperty method to set named property.
The iPalFlag parameter is a set of flags that are or-ed together. Currently this parameter is only used to specify whether a JIDLArray being passed in to IDL is convolved or not. For arrays argpal should be set to either JIDLConst.PARMFLAG_CONVMAJORITY or JIDLConst.PARMFLAG_NO_CONVMAJORITY.
setProperty in interface JIDLObjectI
sProperty - the property name
obj - object to be passed to IDL. Should be an object of type JIDLNumber, JIDLObject, JIDLString or JIDLObject.
iPalFlag - flag denoting whether the passed in parameter is convolved or not. Note: setProperty does not allow obj to be modified by IDL
JIDLException - If IDL encounters an error.
JIDLNumber, JIDLObject, JIDLString, JIDLArray, JIDLConst.PARMFLAG_CONVMAJORITY, JIDLConst.PARMFLAG_NO_CONVMAJORITY
public java.lang.String toString()
Returns a string representation of the object.
toString in class Component
public void update(java.awt.Graphics g)
Internal use. Update the Canvas. (Do not override this method)
update in class Canvas